Conventional Commits
コミットメッセージの規約の一つ
コミットメッセージの先頭に、どういうコミットががわかるようなプレフィクスをつける規約
コードがどういう修正であるかという「意図」が一目でわかるようになる
feat(api)という風に(api)スコープを書いておけば「どの範囲」の修正点かがすぐにわかるコミットメッセージだといえる
プレフィクスをつけることで、プルリクエストでのレビューがしやすかったり、継続的インテグレーション(CI)のときに自動で処理がするなどができるようになる(といわれている) 例:
変更履歴(CHANGELOG)の自動生成
特定のコミット種別をトリガーにしたアクションの実行
code:COMMIT_MESSAGE
type: コミットの種類、コミット種別
[optional scope]: typeで
description: コミットで行った変更の内容
optional body: 本文
optional footer(s): フッター
code:memo
feat: 新機能の追加や変更
fix: バグ修正
docs: ドキュメントの変更
style: コードスタイルの変更(フォーマットの修正など)
refactor: コードの再構築やリファクタリング
test: テストコードの追加や変更
chore: ビルドプロセスや開発環境の変更
ci: CI設定ファイルやスクリプトの変更
perf: パフォーマンスを向上させるもの
Angularはコミットメッセージをテンプレート化したものを使用している
便利なコミットメッセージを生成するnodejsのパッケージ
依存関係についてのコミット
確認用
Q. Conventional Commits
Q. プレフィクスとは
Q. Conventional Commitsに従うと何がいいのか
参考
関連